home *** CD-ROM | disk | FTP | other *** search
/ Beginning Mac Programming / Beginning Mac Programming.bin / Open Me for REALbasic 3 / REALbasic 3.2 / Example Projects / Techniques / Prefmaker / PrefMaker Readme < prev   
Text File  |  1998-06-03  |  4KB  |  96 lines
  1. Pref Maker
  2. a snappy name for a REALbasic class called prefFileItem
  3.  
  4.  
  5. Hope you find this useful.
  6. Email me with any comments or suggestions.  dzouras@wwa.com
  7. -Don Zouras  1998
  8. -----------------
  9.  
  10. This is a quick attempt at some documentation.  Feel free to use this code in anyway you like.
  11. I would appreciate it if you left my credits in the class.
  12.  
  13. Don Zouras 1998
  14. dzouras@wwa.com
  15.  
  16. *********************************************************************************************
  17.  
  18. PrefMaker is a class which provides an object and methods to easily manage a text based
  19. preferences file in the form
  20.  
  21. --------------------------------------------------
  22.  
  23. [Section1]
  24. item=value
  25. another=value2
  26.  
  27. [Another Section]
  28. morestuff=more's value
  29. big=a whole string of info that you want to store
  30.  
  31. --------------------------------------------------
  32.  
  33. The important points are:
  34.  1.  each section name is surrounded by brackets
  35.  2.  each item is joined with it's value by the equal sign (=)
  36.  3.  each line ends with a CHR(13)
  37.  4.  the same item name can be under multiple sections, all methods use section name as part of key
  38.  
  39. You really don't have to know these things if you only use the methods of the prefFileItem class,
  40. because that is the whole reason for it... to free you from some of the work.  I only include the
  41. info so you know what I am doing and in case you want to manually edit the resulting pref file.  That
  42. is one of the reasons I prefer a text preferences files instead of a binary file.  Yes, I know this 
  43. format looks just like that of certain initialization files on another OS, but what can I say...
  44. coincidence?  
  45.  
  46. The prefFileItem class consists of:
  47.  
  48. fileInfo as folderItem - stores the system related info about the pref file
  49. fileText as string - stores the entire pref file in a string for runtime use by methods
  50. saved as boolean - indicates whether changes to fileText have been written to disk
  51.  
  52. and...
  53.  
  54. Methods:
  55.  
  56. Name            Args                    Description
  57. -----------------------------------------------------------------------------------------
  58. clear            no arguments            clears the fileText property of the prefFileItem
  59.  
  60. deleteItem        sectionName as String     deletes the item with itemName
  61.                 itemName as String        in sectionName
  62.                                                             
  63. deleteSection    sectionName as String    deletes the sectionName
  64.  
  65. getText            prefFile as String        gets the contents of file named prefFile in
  66.                                         System:Preferences
  67.                                         
  68. putText            no arguments            writes the fileText to the file in the
  69.                                         fileInfo folderItem
  70.                                         
  71. readItem()        sectionName as String     returns the item with itemName
  72.                 itemName as String        in sectionName, if not found, returns null
  73.                 
  74. setCreatorType    creator as String        sets the creator and type of the 
  75.                 type as String            fileInfo folderItem
  76.             
  77. writeItem        sectionName as String    adds the itemName = itemValue line under
  78.                 itemName as String        sectionName.  If itemName exists the itemValue
  79.                 itemValue as String        will overwrite it.  If sectionName or itemName
  80.                                         do not exist, they will be created.
  81.                                         
  82.                                         
  83. Misc. Notes:
  84.  
  85. The clear, delete, and write methods act on the fileText property.  Reads will also act on the text
  86. that is kept in memory.  Changes will only be saved to disk if the putText method is used.
  87.  
  88. The class is included in the sample application.  You must export it before you can use it in your 
  89. own projects.
  90.  
  91. To use this class you must DIM a prefFileItem first.  Then make sure you NEW the objects.
  92. See the sample app for examples.  I know it's not the best example, but hey, learning is part of the
  93. fun right?  OK, I'm just too lazy.
  94.  
  95.  
  96.